/***********************************************************************
    filename:   ComponentBase.h
    created:    Mon Jul 18 2005
    author:     Paul D Turner <paul@cegui.org.uk>
*************************************************************************/

#ifndef _ComponentBase_h_
#define _ComponentBase_h_

#include "../hgecolor.h"
#include "../hgeRect.h"
#include "../hgeForwardRef.h"

/*!
\brief
    Common base class used for renderable components within an ImagerySection.
*/
class ComponentBase
{
public:
    ComponentBase();
    virtual ~ComponentBase();

    /*!
    \brief
        Render this component.  More correctly, the component is cached for rendering.

    \param srcWindow
        Window to use as the base for translating the component's hgeRect into pixel values.

    \param modColours
        ColourRect describing colours that are to be modulated with the component's stored colour values
        to calculate a set of 'final' colour values to be used.  May be 0.

    \return
        Nothing.
    */
    void render(Window& srcWindow, const ColourRect* modColours = 0, const hgeRect* clipper = 0, bool clipToDisplay = false) const;

    /*!
    \brief
        Render this component.  More correctly, the component is cached for rendering.

    \param srcWindow
        Window to use as the base for translating the component's hgeRect into pixel values.

    \param baseRect
        hgeRect to use as the base for translating the component's hgeRect into pixel values.

    \param modColours
        ColourRect describing colours that are to be modulated with the component's stored colour values
        to calculate a set of 'final' colour values to be used.  May be 0.

    \return
        Nothing.
    */
    void render(Window& srcWindow, const hgeRect& baseRect, const ColourRect* modColours = 0, const hgeRect* clipper = 0, bool clipToDisplay = false) const;

    /*!
    \brief
        Return the hgeRect of this ImageryComponent.

    \return
        hgeRect object describing the ImageryComponent's current target area.
    */
    const hgeRect& getComponentArea() const;

    /*!
    \brief
        Set the ImageryComponent's hgeRect.

    \param area
        hgeRect object describing a new target area for the ImageryComponent.

    \return
        Nothing.
    */
    void setComponentArea(const hgeRect& area);

    /*!
    \brief
        Return the ColourRect set for use by this ImageryComponent.

    \return
        ColourRect object holding the colours currently in use by this ImageryComponent.
    */
    const ColourRect& getColours() const;

    /*!
    \brief
        Set the colours to be used by this ImageryComponent.

    \param cols
        ColourRect object describing the colours to be used by this ImageryComponent.
    */
    void setColours(const ColourRect& cols);

    /*!
    \brief
        Set the name of the property where colour values can be obtained.

    \param property
        String containing the name of the property.

    \return
        Nothing.
    */
    void setColoursPropertySource(const String& property);

    /*!
    \brief
        Set whether the colours property source represents a full ColourRect.

    \param setting
        - true if the colours property will access a ColourRect object.
        - false if the colours property will access a colour object.

    \return
        Nothing.
    */
    void setColoursPropertyIsColourRect(bool setting = true);

    /*!
    \brief
        Set the name of the property where vertical formatting option can be obtained.

    \param property
        String containing the name of the property.

    \return
        Nothing.
    */
    void setVertFormattingPropertySource(const String& property);

    /*!
    \brief
        Set the name of the property where horizontal formatting option can be obtained.

    \param property
        String containing the name of the property.

    \return
        Nothing.
    */
    void setHorzFormattingPropertySource(const String& property);

protected:
    /*!
    \brief
        Helper method to initialise a ColourRect with appropriate values according to the way the
        ImageryComponent is set up.

        This will try and get values from multiple places:
            - a property attached to \a wnd
            - or the integral d_colours value.
    */
    void initColoursRect(const Window& wnd, const ColourRect* modCols, ColourRect& cr) const;

    /*!
    \brief
        Method to do main render caching work.
    */
    virtual void render_impl(Window& srcWindow, hgeRect& destRect, const ColourRect* modColours, const hgeRect* clipper, bool clipToDisplay) const = 0;

    // data fields
    hgeRect			d_area;                 //!< Destination area for this component.
    ColourRect      d_colours;              //!< base colours to be applied when rendering the image component.
    String          d_colourPropertyName;   //!< name of property to fetch colours from.
    bool            d_colourProperyIsRect;  //!< true if the colour property will fetch a full ColourRect.
    String          d_vertFormatPropertyName;   //!< name of property to fetch vertical formatting setting from.
    String          d_horzFormatPropertyName;   //!< name of property to fetch horizontal formatting setting from.
};

#endif  // end of guard _ComponentBase_h_
